home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dskut / quick10.zip / Q.DOC < prev    next >
Text File  |  1994-06-15  |  8KB  |  195 lines
  1.                               QuickDoc v1.1 
  2.                       (c) Dr Grieve Software 1994
  3.  
  4. **What is this doc is about: explanation of QuickChange v1.5, QuickLoad v1.0 
  5. and QuickXcopy v1.0. Hopefully you will only need to read this document once.
  6.  
  7. **What does it do: the purpose of these programs is to perform the functions 
  8. loading programs, changing between directories and copying files between 
  9. directories, much easier and faster by the use of an alias.
  10.  
  11. **Why did I write these Quick programs: To save me time!
  12.  
  13. **How does Quick save me time? Well if you delve into dos it will 1. reduce 
  14. typing. 2. reduce the number of batch files that you have to maintain. (I 
  15. used to have a multitude of batch files, whose only purpose were to change to 
  16. a directory or load a program.) 3. avoid the agony of maintaining a menu.
  17.  
  18. **How do I run a Quick program:
  19.  
  20. Each program will display a help message if you execute them with no commands
  21. or aliases. The help message will display available commands and give a short
  22. description of them. See **Commands for more information.
  23.  
  24. **What is this alias business:
  25.  
  26. An alias is an substitute for a name. An alias is generally shorter or easier 
  27. to type than the name would be. In the Quick programs the alias defaults to
  28. the top directory and in QuickLoad the filename defaults to the top directory
  29. plus the extension '.exe'.
  30.  
  31. **What does QuickChange do:
  32.  
  33. This program lets you move between directories with the use of an alias. It
  34. also provides functions that make the maintenance of the Q.DAT file very easy.
  35.  
  36. **What does QuickLoad do:
  37.  
  38. This program loads up a program with the use of an alias. It also provides
  39. functions, similar to those in QuickChange, that make the maintenance of the
  40. Q.DAT file very easy.
  41.  
  42. **What does QuickXcopy do:
  43.  
  44. This program lets you use aliases in the command line of Xcopy or Move. It
  45. simply replaces the aliases you specify, with their full path and passes to 
  46. the appropriate command.
  47.  
  48. **What is the file Q.DAT: 
  49.  
  50.  You can use the add function in QuickChange or QuickLoad, or you could use
  51. a text editor. Each line in q.dat refers to a directory in QuickChange or
  52. QuickXcopy, or to a directory and a filename in Quickload. Each line should 
  53. follow this pattern:
  54.  
  55.   [alias] path [filename]  
  56.  
  57.  The four different possibilities:
  58.  
  59. c:\games
  60. vik d:\games\vikings
  61. c:\apps\programs\tp turbo.exe
  62. wp c:\apps\wp51 wp.bat
  63.  
  64.  where the aliases and filenames are: 
  65.  
  66. games games.exe    (note: the file games.exe doesn't exist, QuickLoad will 
  67. vik   vikings.exe   return an error if you try to ql games)
  68. tp    turbo.exe
  69. wp    wp.bat
  70.  
  71. **Commands
  72.  
  73.   **QuickChange
  74.  
  75.     **/a [alias]   { Add command }
  76. This command automatically places the current directory into the Q.DAT file
  77. using the last directory as the alias. You can create a different alias by
  78. specifying it after the /a command. For example:
  79.  
  80. C:\GAMES\DOOM>qc /a   (creates the line c:\games\doom)
  81.  
  82. C:\GAMES>qc /a g      (creates the line g c:\games)
  83.  
  84.    **/d alias      { Delete command }
  85. This command deletes the specified alias from the Q.DAT file. For example if
  86. the Q.DAT file contained the following lines:
  87.  
  88. c:\games\doom
  89. g c:\games
  90.  
  91. Then qc /d doom would delete the first line, and qc /d g would delete the
  92. second.
  93.  
  94.     **/s or /sp    { Show command }
  95. Simply displays the contents of the Q.DAT file in order of alias (default) or
  96. by path (the /sp command).
  97.  
  98.     **/t           { Test Command }
  99. Tests the Q.DAT file for invalid path specifications. A valid path will become
  100. invalid if you remove a directory that was in it!
  101.  
  102.     **/td          { Test and Delete Command }
  103. Automatically deletes any invalid path QuickChange discovers. A handy way to
  104. tidy up your Q.DAT file.
  105.  
  106.  
  107.   **QuickLoad (commands are very similar to QuickChange)
  108.  
  109.     **/a           { Add Command }
  110. The same as above except you can specify the filename.ext as well. Remember 
  111. the default filename is the top directory plus the extension '.exe'.
  112.  
  113.     **/d           { Delete Command }
  114. Same as above
  115.  
  116.     **/s, /sp, /sf { Show Command }
  117. This command will display, in order of alias, path, or filename, all valid 
  118. filenames. That is which ones you can load at this moment.
  119.  
  120.   **QuickXcopy (read the help files on Xcopy /? or Move /? for more info)
  121.  
  122.     **/m           { Move Command }
  123. This command uses Move instead of defaulting to Xcopy. 
  124.                                                       
  125. **Clues: 
  126. 1. The aliases are case sensitive. 
  127. 2. The current directory is searched first for the Q.DAT file. That is you can
  128.    have multiple Q.DAT files, this is useful when using floppy disks.
  129. 3. Don't try to reformat the data file, that is add spaces or tabs.
  130. 4. Store the Quick executables, ie QC.EXE, QL.EXE and QX.EXE, and the data 
  131. file Q.DAT in a directory which is mentioned near the start of the path 
  132. command in your AUTOEXEC.BAT. For example in the AUTOEXEC.BAT have a path 
  133. something like this:
  134.  
  135.   path = c:\;c:\dos;c:\utils\dosb;c:\apps\norton
  136.  
  137. and store the above files in the directory dosb. This will make sure Dos will
  138. not have to search through too many files to find a Quick program.
  139.  
  140. **Exit Codes: Useful if you like this sort of thing
  141. 0 - normal exit
  142. 1 - could not find data file Q.DAT
  143. 3 - invalid path, tried to change to an non-existing directory
  144. 4 - invalid input, either from the keyboard or from the data file Q.DAT
  145.  
  146. **History of Quick
  147. QuickChange
  148. 1.0 Written in c++, very basic, was 45k in size. Was Freeware.
  149. 1.1 Converted program to turbo pascal, exe file now 5 times smaller.
  150.     During the conversion I made the program more maintainable for further
  151.     versions, and I tidied up (slightly) the show command. Was Freeware.
  152. 1.5 Added the commands add, delete, test, test & delete, and enhanced the show
  153.     command. Now Shareware
  154.  
  155. QuickLoad
  156. 1.0 Based on QuickChange. Makes use of conventional memory swapping so that 
  157.     almost all memory is still available to the loaded programs.
  158.  
  159. QuickXcopy
  160. 1.0 Allows the full use of Dos 6.2's xcopy and move.
  161.  
  162. **Further Versions
  163.  In further version of QuickChange and QuickLoad I intend to further optimise 
  164. the code and introduce more basic user error capture.
  165.  I intend to produce two further programs, QuickMenu and QuickSelect. 
  166. QuickMenu will be a dynamic 90% automaintainable menu system, and QuickSelect 
  167. will be a handy front-end utility for the many command line programs that load 
  168. up a single file, eg playfile or mp. I will bundle these programs together and 
  169. release them as shareware, in QUICK11.ZIP. 
  170.  In REG.DOC I explain that upon registering you receive free all versions
  171. now and in the future of all the Quick family.
  172.  
  173. **Hooha
  174. This program is Shareware, please read REG.DOC to understand the conditions   
  175. on how you may use the Quick programs. You can distribute all of the Quick
  176. programs, all I ask is that you keep all of the files intact, and adhere to
  177. my numbering system for the ZIP files. 
  178.  
  179. The bundle QUICK10.ZIP should contain the following files, if it does not,
  180. you can obtain the proper files at a popular FTP site or write to me at my 
  181. email address or my home address. (In the REG.DOC file).
  182.  
  183.   QUICK10.ZIP
  184.               QC.EXE  13,312 QuickChange v1.5
  185.               QL.EXE  24,528 QuickLoad v1.0
  186.               QX.EXE   9,744 QuickXcopy v1.0
  187.               Q.DOC    7,742 QuickDoc v1.1
  188.               REG.DOC  2,737 Registration Doc
  189.               Q.DAT       12 Sample Data File
  190.  
  191. **Request: If you can think of a way to improve any of these programs please 
  192. send your idea(s) via email. 
  193.  
  194.       My address for this year (1994) is IS30225@otago.ac.nz. Thanks.
  195.